qaGobiApiUim.h

Go to the documentation of this file.

/*
 * Copyright: © 2012-2015 Sierra Wireless, Inc. all rights reserved
 */
#ifndef __GOBI_API_UIM_H__
#define __GOBI_API_UIM_H__

#ifdef __cplusplus
extern "C" {
#endif

#define MAX_DESCRIPTION_LENGTH 255
#define MAX_CONTENT_LENGTH     1024
#define MAX_NO_OF_APPLICATIONS 10
#define MAX_NO_OF_SLOTS        5
#define MAX_PUK_LENGTH         8
#define MAX_PATH_LENGTH        255
#define MAX_ICCID_LENGTH       255
#define MAX_SLOTS_STATUS       255

#define MAX_ACTIVE_PERS_FEATURES   12

ULONG SLQSUIMReset();

typedef struct
{
    BYTE slot;
} UIMPowerDownReq;

ULONG SLQSUIMPowerDown ( UIMPowerDownReq *pUIMPowerDownReq );

typedef struct {
    WORD  fileID;
    BYTE  pathLen;
    WORD  path[MAX_PATH_LENGTH];
} fileInfo;

typedef struct
{
    /* Every response message must have a results structure */
    struct qmTlvResult results;
    BYTE     stage;
    BYTE     mode;
    BYTE     sessionType;
    BYTE     aidLength;
    BYTE     aid[MAX_DESCRIPTION_LENGTH];
    WORD     numOfFiles;
    fileInfo arrfileInfo[MAX_DESCRIPTION_LENGTH];
} UIMRefreshEvent;

typedef struct
{
    BYTE appType;
    BYTE appState;
    BYTE persoState;
    BYTE persoFeature;
    BYTE persoRetries;
    BYTE persoUnblockRetries;
    BYTE aidLength;
    BYTE aidVal[MAX_DESCRIPTION_LENGTH];
    BYTE univPin;
    BYTE pin1State;
    BYTE pin1Retries;
    BYTE puk1Retries;
    BYTE pin2State;
    BYTE pin2Retries;
    BYTE puk2Retries;
} appStatus;

typedef struct
{
    BYTE      cardState;
    BYTE      upinState;
    BYTE      upinRetries;
    BYTE      upukRetries;
    BYTE      errorState;
    BYTE      numApp;
    appStatus AppStatus[MAX_NO_OF_APPLICATIONS];
} slotInfo;

typedef struct
{
    WORD     indexGwPri;
    WORD     index1xPri;
    WORD     indexGwSec;
    WORD     index1xSec;
    BYTE     numSlot;
    slotInfo SlotInfo[MAX_NO_OF_SLOTS];
} cardStatus;

typedef struct
{
    BYTE hotSwapLength;
    BYTE hotSwap[MAX_DESCRIPTION_LENGTH];
} hotSwapStatus;

typedef struct
{
    BYTE validCardLength;
    BYTE validCard[MAX_DESCRIPTION_LENGTH];
} validCardStatus;

typedef struct
{
    BYTE simBusyLength;
    BYTE simBusy[MAX_DESCRIPTION_LENGTH];
} simBusyStatus;

typedef struct
{
    cardStatus    *pCardStatus;
    hotSwapStatus *pHotSwapStatus;
} UIMGetCardStatusResp;

typedef struct
{
    cardStatus    *pCardStatus;
    hotSwapStatus *pHotSwapStatus;
    validCardStatus *pValidCardStatus;
    simBusyStatus *pSimBusyStatus;
} UIMGetCardStatusRespV2;


ULONG SLQSUIMGetCardStatus ( UIMGetCardStatusResp *pUIMGetCardStatusResp );


ULONG SLQSUIMGetCardStatusV2 ( UIMGetCardStatusRespV2 *pUIMGetCardStatusResp );

typedef struct
{
    BYTE sw1;
    BYTE sw2;
} cardResult;

typedef struct
{
    BYTE   sessionType;
    BYTE   aidLength;
    BYTE   aid[MAX_DESCRIPTION_LENGTH];
} UIMSessionInformation ;

typedef struct
{
    BYTE pinID;
    BYTE pinOperation;
    BYTE pinLength;
    BYTE pinValue[MAX_DESCRIPTION_LENGTH];
} setPINProtection;

typedef struct
{
    UIMSessionInformation sessionInfo;
    setPINProtection      pinProtection;
    BYTE                  *pKeyReferenceID;
    ULONG                 *pIndicationToken;
} UIMSetPinProtectionReq ;

typedef struct
{
    BYTE verifyLeft;
    BYTE unblockLeft;
} remainingRetries;

typedef struct
{
    BYTE pin1Len;
    BYTE pin1Val[MAX_DESCRIPTION_LENGTH];
} encryptedPIN1;

typedef struct
{
    remainingRetries *pRemainingRetries;
    encryptedPIN1    *pEncryptedPIN1;
    ULONG            *pIndicationToken;
} UIMPinResp;

typedef struct
{
    remainingRetries *pRemainingRetries;
    encryptedPIN1    *pEncryptedPIN1;
    ULONG            *pIndicationToken;
    cardResult       *pCardResult;
} UIMPinRespV2;

ULONG SLQSUIMSetPinProtection (
                UIMSetPinProtectionReq *pUIMSetPinProtectionReq,
                UIMPinResp             *pUIMSetPinProtectionResp );

typedef struct{
    BYTE pinID;
    BYTE pinLen;
    BYTE pinVal[MAX_DESCRIPTION_LENGTH];
} verifyUIMPIN;

typedef struct
{
    UIMSessionInformation sessionInfo;
    verifyUIMPIN          verifyPIN;
    encryptedPIN1         *pEncryptedPIN1;
    BYTE                  *pKeyReferenceID;
    ULONG                 *pIndicationToken;
} UIMVerifyPinReq;

ULONG SLQSUIMVerifyPin ( UIMVerifyPinReq *pUIMVerifyPinReq,
                         UIMPinResp      *pUIMVerifyPinResp );

typedef struct{
    BYTE pinID;
    BYTE oldPINLen;
    BYTE oldPINVal[MAX_DESCRIPTION_LENGTH];
    BYTE pinLen;
    BYTE pinVal[MAX_DESCRIPTION_LENGTH];
} changeUIMPIN;

typedef struct
{
    UIMSessionInformation sessionInfo;
    changeUIMPIN          changePIN;
    BYTE                  *pKeyReferenceID;
    ULONG                 *pIndicationToken;
} UIMChangePinReq;

ULONG SLQSUIMChangePin ( UIMChangePinReq *pUIMChangePinReq,
                         UIMPinResp      *pUIMChangePinResp );

typedef struct{
    BYTE pinID;
    BYTE pukLen;
    BYTE pukVal[MAX_DESCRIPTION_LENGTH];
    BYTE newPINLen;
    BYTE newPINVal[MAX_DESCRIPTION_LENGTH];
} unblockUIMPIN;

typedef struct
{
    UIMSessionInformation sessionInfo;
    unblockUIMPIN         unblockPIN;
    BYTE                  *pKeyReferenceID;
    ULONG                 *pIndicationToken;
} UIMUnblockPinReq;

ULONG SLQSUIMUnblockPin ( UIMUnblockPinReq *pUIMUnblockPinReq,
                          UIMPinResp       *pUIMUnblockPinResp );

ULONG SLQSUIMUnblockPinV2 ( UIMUnblockPinReq *pUIMUnblockPinReq,
                            UIMPinRespV2       *pUIMUnblockPinResp );

typedef struct
{
    ULONG eventMask;
} UIMEventRegisterReqResp;

ULONG SLQSUIMEventRegister (
    UIMEventRegisterReqResp *pUIMEventRegisterReqResp );

typedef struct
{
    UIMSessionInformation sessionInfo;
    BYTE                  OKtoRefresh;
} UIMRefreshOKReq;

ULONG SLQSUIMRefreshOK (
    UIMRefreshOKReq *pUIMRefreshOKReq );

typedef struct
{
    BYTE     registerFlag;
    BYTE     voteForInit;
    WORD     numFiles;
    fileInfo arrfileInfo[MAX_DESCRIPTION_LENGTH];
} registerRefresh;

typedef struct
{
    UIMSessionInformation sessionInfo;
    registerRefresh       regRefresh;
} UIMRefreshRegisterReq;

ULONG SLQSUIMRefreshRegister(
    UIMRefreshRegisterReq *pUIMRefreshRegisterReq );

typedef struct
{
    UIMSessionInformation  sessionInfo;
    BYTE                   refreshComplete;
} UIMRefreshCompleteReq;


ULONG SLQSUIMRefreshComplete (
    UIMRefreshCompleteReq *pUIMRefreshCompleteReq );

typedef struct
{
    UIMRefreshEvent *pRefreshEvent;
} UIMRefreshGetLastEventResp;

typedef struct
{
    UIMSessionInformation sessionInfo;
} UIMRefreshGetLastEventReq;

ULONG SLQSUIMRefreshGetLastEvent (
    UIMRefreshGetLastEventReq  *pUIMRefreshGetLastEventReq,
    UIMRefreshGetLastEventResp *pUIMRefreshGetLastEventResp );

typedef struct
{
    UIMSessionInformation sessionInfo;
    fileInfo              fileIndex;
    ULONG                 *pIndicationToken;
} UIMGetFileAttributesReq;

typedef struct
{
    WORD fileSize;
    WORD fileID;
    BYTE fileType;
    WORD recordSize;
    WORD recordCount;
    BYTE secRead;
    WORD secReadMask;
    BYTE secWrite;
    WORD secWriteMask;
    BYTE secIncrease;
    WORD secIncreaseMask;
    BYTE secDeactivate;
    WORD secDeactivateMask;
    BYTE secActivate;
    WORD secActivateMask;
    WORD rawLen;
    BYTE rawValue[MAX_DESCRIPTION_LENGTH];
} fileAttributes;

typedef struct
{
    cardResult     *pCardResult;
    fileAttributes *pFileAttributes;
    ULONG          *pIndicationToken;
} UIMGetFileAttributesResp;

ULONG SLQSUIMGetFileAttributes (
                      UIMGetFileAttributesReq  *pUIMGetFileAttributesReq,
                      UIMGetFileAttributesResp *pUIMGetFileAttributesResp );

typedef struct{
    BYTE  feature;
    BYTE  operation;
    BYTE  ckLen;
    BYTE  ckVal[MAX_DESCRIPTION_LENGTH];
} depersonalizationInformation;

typedef struct
{
    depersonalizationInformation depersonilisationInfo;
} UIMDepersonalizationReq;

typedef struct
{
    remainingRetries *pRemainingRetries;
} UIMDepersonalizationResp;

ULONG SLQSUIMDepersonalization (
                      UIMDepersonalizationReq  *pUIMDepersonilizationReq,
                      UIMDepersonalizationResp *pUIMDepersonilizationResp );

typedef struct
{
    BYTE context;
    WORD dataLen;
    BYTE data[MAX_CONTENT_LENGTH];
} authenticationData;

typedef struct
{
    UIMSessionInformation sessionInfo;
    authenticationData    authData;
    ULONG                 *pIndicationToken;
} UIMAuthenticateReq;

typedef struct
{
    WORD contentLen;
    BYTE content[MAX_CONTENT_LENGTH];
} authenticateResult;

typedef struct
{
    cardResult         *pCardResult;
    authenticateResult *pAuthenticateResult;
    ULONG              *pIndicationToken;
} UIMAuthenticateResp;

ULONG SLQSUIMAuthenticate ( UIMAuthenticateReq  *pUIMAuthenticateReq,
                            UIMAuthenticateResp *pUIMAuthenticateResp);
typedef struct
{
    WORD contentLen;
    BYTE content[MAX_DESCRIPTION_LENGTH+1];
} readResult;

typedef struct
{
    WORD offset;
    WORD length;
} readTransparentInfo;

typedef struct
{
    UIMSessionInformation sessionInfo;
    fileInfo              fileIndex;
    readTransparentInfo   readTransparent;
    ULONG                 *pIndicationToken;
    BYTE                  *pEncryptData;
} UIMReadTransparentReq;

typedef struct
{
    cardResult   *pCardResult;
    readResult   *pReadResult;
    ULONG        *pIndicationToken;
    BYTE         *pEncryptedData;
} UIMReadTransparentResp;

ULONG SLQSUIMReadTransparent (
        UIMReadTransparentReq  *pUIMReadTransparentReq,
        UIMReadTransparentResp *pUIMReadTransparentResp );

typedef struct
{
    BYTE slot;
    BYTE *pIgnoreHotSwapSwitch;
} UIMPowerUpReq;

ULONG SLQSUIMPowerUp ( UIMPowerUpReq *pUIMPowerUpReq );

typedef struct
{
    ULONG   uPhyCardStatus;
    ULONG   uPhySlotStatus;
    BYTE    bLogicalSlot;
    BYTE    bICCIDLength;
    BYTE    bICCID[MAX_ICCID_LENGTH];
}UIMSlotStatus;

typedef struct
{
    UIMSlotStatus uimSlotStatus[MAX_SLOTS_STATUS];
}UIMSlotsStatus;

typedef struct
{
    BYTE    *pNumberOfPhySlot;
    UIMSlotsStatus *pUimSlotsStatus;
} UIMGetSlotsStatusResp;

ULONG SLQSUIMGetSlotsStatus(UIMGetSlotsStatusResp *pResp);


typedef struct
{
    BYTE bLogicalSlot;
    ULONG ulPhysicalSlot;
}UIMSwitchSlotReq;

ULONG SLQSUIMSwitchSlot(UIMSwitchSlotReq *pReq );

typedef struct
{
    BYTE numFeatures;
    BYTE feature[MAX_ACTIVE_PERS_FEATURES];
    BYTE verifyLeft[MAX_ACTIVE_PERS_FEATURES];
    BYTE unblockLeft[MAX_ACTIVE_PERS_FEATURES];
} personalizationStatus;

typedef struct
{
    ULONG                 *pConfigurationMask;
} UIMGetConfigurationReq;

typedef struct
{
    BYTE                   *pAutoSelection;
    personalizationStatus  *pPersonalizationStatus;
    BYTE                   *pHaltSubscription;
} UIMGetConfigurationResp;

ULONG SLQSUIMGetConfiguration (
        UIMGetConfigurationReq  *pUIMGetConfigurationReq,
        UIMGetConfigurationResp *pUIMGetConfigurationResp );

#ifdef __cplusplus
} /* extern "C" { */
#endif

#endif /* __GOBI_API_UIM_H__ */